<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
 <head>
  <meta http-equiv="content-type" content="text/html; charset=UTF-8">
  <title>Compresses all files in the current Phar archive using Gzip compression</title>

 </head>
 <body><div class="manualnavbar" style="text-align: center;">
 <div class="prev" style="text-align: left; float: left;"><a href="phar.compressallfilesbzip2.html">Phar::compressAllFilesBZIP2</a></div>
 <div class="next" style="text-align: right; float: right;"><a href="phar.compressfiles.html">Phar::compressFiles</a></div>
 <div class="up"><a href="class.phar.html">Phar</a></div>
 <div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="phar.compressallfilesgz" class="refentry">
 <div class="refnamediv">
  <h1 class="refname">Phar::compressAllFilesGZ</h1>
  <p class="verinfo">(PHP &gt;= 5.3.0, PECL phar &gt;= 1.0.0)</p><p class="refpurpose"><span class="refname">Phar::compressAllFilesGZ</span> &mdash; <span class="dc-title">Compresses all files in the current Phar archive using Gzip compression</span></p>

 </div>

 <div class="refsect1 description" id="refsect1-phar.compressallfilesgz-description">
  <h3 class="title">说明</h3>
  <div class="methodsynopsis dc-description">
   <span class="modifier">public</span> <span class="type">bool</span> <span class="methodname"><strong>Phar::compressAllFilesGZ</strong></span>
    ( <span class="methodparam">void</span>
   )</div>

  <blockquote class="note"><p><strong class="note">Note</strong>: <p class="para">此方法已经从 phar
扩展 2.0.0以上版本中删除。可使用
<span class="function"><a href="phar.compress.html" class="function">Phar::compress()</a></span>，<span class="function"><a href="phar.decompress.html" class="function">Phar::decompress()</a></span>，<span class="function"><a href="phar.compressfiles.html" class="function">Phar::compressFiles()</a></span>
和 <span class="function"><a href="phar.decompressfiles.html" class="function">Phar::decompressFiles()</a></span>替代。</p></p></blockquote>
  <blockquote class="note"><p><strong class="note">Note</strong>: <p class="para">此方法需要
将 <var class="filename">php.ini</var> 中的 <em>phar.readonly</em> 设为
<em>0</em> 以适合 <a href="class.phar.html" class="classname">Phar</a>
对象.  否则, 将抛出<a href="class.pharexception.html" class="classname">PharException</a>.</p></p></blockquote>

  <p class="para">
   For tar-based phar archives, this method compresses the entire archive using
   gzip compression.  The resulting file can be processed with the gunzip command, or
   accessed directly and transparently with the Phar extension.
  </p>
  <p class="para">
   For Zip-based and phar-based phar archives, this method compresses all files in the
   Phar archive using gzip compression.
   The <a href="ref.zlib.html" class="link">zlib</a> extension must be enabled to take
   advantage of this feature.  In addition, if any files are already compressed using
   bzip2 compression, the <a href="ref.bzip2.html" class="link">bzip2</a> extension must be
   enabled in order to decompress the files prior to re-compressing with gzip compression.
   As with all functionality that modifies the contents of a phar, the
   <a href="phar.configuration.html#ini.phar.readonly" class="link">phar.readonly</a> INI variable must be off
   in order to succeed.
  </p>
 </div>


 <div class="refsect1 returnvalues" id="refsect1-phar.compressallfilesgz-returnvalues">
  <h3 class="title">返回值</h3>
  <p class="para">
   成功时返回 <strong><code>TRUE</code></strong>， 或者在失败时返回 <strong><code>FALSE</code></strong>。
  </p>
 </div>


 <div class="refsect1 errors" id="refsect1-phar.compressallfilesgz-errors">
  <h3 class="title">错误／异常</h3>
  <p class="para">
   Throws <a href="class.badmethodcallexception.html" class="classname">BadMethodCallException</a> if
   the <a href="phar.configuration.html#ini.phar.readonly" class="link">phar.readonly</a>
   INI variable is on, the <a href="ref.zlib.html" class="link">zlib</a>
   extension is not available, or if any files are compressed using
   bzip2 compression and the <a href="ref.bzip2.html" class="link">bzip2</a> extension
   is not enabled.
  </p>
 </div>


 <div class="refsect1 examples" id="refsect1-phar.compressallfilesgz-examples">
  <h3 class="title">范例</h3>
  <p class="para">
   <div class="example" id="example-641">
    <p><strong>Example #1 A <span class="function"><strong>Phar::compressAllFilesGZ()</strong></span> example</strong></p>
    <div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB">&lt;?php<br />$p&nbsp;</span><span style="color: #007700">=&nbsp;new&nbsp;</span><span style="color: #0000BB">Phar</span><span style="color: #007700">(</span><span style="color: #DD0000">'/path/to/my.phar'</span><span style="color: #007700">,&nbsp;</span><span style="color: #0000BB">0</span><span style="color: #007700">,&nbsp;</span><span style="color: #DD0000">'my.phar'</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">$p</span><span style="color: #007700">[</span><span style="color: #DD0000">'myfile.txt'</span><span style="color: #007700">]&nbsp;=&nbsp;</span><span style="color: #DD0000">'hi'</span><span style="color: #007700">;<br /></span><span style="color: #0000BB">$p</span><span style="color: #007700">[</span><span style="color: #DD0000">'myfile2.txt'</span><span style="color: #007700">]&nbsp;=&nbsp;</span><span style="color: #DD0000">'hi'</span><span style="color: #007700">;<br />foreach&nbsp;(</span><span style="color: #0000BB">$p&nbsp;</span><span style="color: #007700">as&nbsp;</span><span style="color: #0000BB">$file</span><span style="color: #007700">)&nbsp;{<br />&nbsp;&nbsp;&nbsp;&nbsp;</span><span style="color: #0000BB">var_dump</span><span style="color: #007700">(</span><span style="color: #0000BB">$file</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">getFileName</span><span style="color: #007700">());<br />&nbsp;&nbsp;&nbsp;&nbsp;</span><span style="color: #0000BB">var_dump</span><span style="color: #007700">(</span><span style="color: #0000BB">$file</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">isCompressed</span><span style="color: #007700">());<br />&nbsp;&nbsp;&nbsp;&nbsp;</span><span style="color: #0000BB">var_dump</span><span style="color: #007700">(</span><span style="color: #0000BB">$file</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">isCompressedBZIP2</span><span style="color: #007700">());<br />&nbsp;&nbsp;&nbsp;&nbsp;</span><span style="color: #0000BB">var_dump</span><span style="color: #007700">(</span><span style="color: #0000BB">$file</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">isCompressedGZ</span><span style="color: #007700">());<br />}<br /></span><span style="color: #0000BB">$p</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">compressAllFilesGZ</span><span style="color: #007700">();<br />foreach&nbsp;(</span><span style="color: #0000BB">$p&nbsp;</span><span style="color: #007700">as&nbsp;</span><span style="color: #0000BB">$file</span><span style="color: #007700">)&nbsp;{<br />&nbsp;&nbsp;&nbsp;&nbsp;</span><span style="color: #0000BB">var_dump</span><span style="color: #007700">(</span><span style="color: #0000BB">$file</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">getFileName</span><span style="color: #007700">());<br />&nbsp;&nbsp;&nbsp;&nbsp;</span><span style="color: #0000BB">var_dump</span><span style="color: #007700">(</span><span style="color: #0000BB">$file</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">isCompressed</span><span style="color: #007700">());<br />&nbsp;&nbsp;&nbsp;&nbsp;</span><span style="color: #0000BB">var_dump</span><span style="color: #007700">(</span><span style="color: #0000BB">$file</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">isCompressedBZIP2</span><span style="color: #007700">());<br />&nbsp;&nbsp;&nbsp;&nbsp;</span><span style="color: #0000BB">var_dump</span><span style="color: #007700">(</span><span style="color: #0000BB">$file</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">isCompressedGZ</span><span style="color: #007700">());<br />}<br /></span><span style="color: #0000BB">?&gt;</span>
</span>
</code></div>
    </div>

    <div class="example-contents"><p>以上例程会输出：</p></div>
    <div class="example-contents screen">
<div class="cdata"><pre>
string(10) &quot;myfile.txt&quot;
bool(false)
bool(false)
bool(false)
string(11) &quot;myfile2.txt&quot;
bool(false)
bool(false)
bool(false)
string(10) &quot;myfile.txt&quot;
bool(true)
bool(false)
bool(true)
string(11) &quot;myfile2.txt&quot;
bool(true)
bool(false)
bool(true)
</pre></div>
    </div>
   </div>
  </p>
 </div>


 <div class="refsect1 seealso" id="refsect1-phar.compressallfilesgz-seealso">
  <h3 class="title">参见</h3>
  <p class="para">
   <ul class="simplelist">
    <li class="member"><span class="function"><a href="pharfileinfo.getcompressedsize.html" class="function" rel="rdfs-seeAlso">PharFileInfo::getCompressedSize()</a> - Returns the actual size of the file (with compression) inside the Phar archive</span></li>
    <li class="member"><span class="function"><a href="pharfileinfo.iscompressedbzip2.html" class="function" rel="rdfs-seeAlso">PharFileInfo::isCompressedBZIP2()</a> - Returns whether the entry is compressed using bzip2</span></li>
    <li class="member"><span class="function"><a href="pharfileinfo.iscompressed.html" class="function" rel="rdfs-seeAlso">PharFileInfo::isCompressed()</a> - Returns whether the entry is compressed</span></li>
    <li class="member"><span class="function"><a href="pharfileinfo.iscompressedgz.html" class="function" rel="rdfs-seeAlso">PharFileInfo::isCompressedGZ()</a> - Returns whether the entry is compressed using gz</span></li>
    <li class="member"><span class="function"><a href="pharfileinfo.setcompressedbzip2.html" class="function" rel="rdfs-seeAlso">PharFileInfo::setCompressedBZIP2()</a> - Compresses the current Phar entry within the phar using Bzip2 compression</span></li>
    <li class="member"><span class="function"><a href="pharfileinfo.setuncompressed.html" class="function" rel="rdfs-seeAlso">PharFileInfo::setUncompressed()</a> - Uncompresses the current Phar entry within the phar, if it is compressed</span></li>
    <li class="member"><span class="function"><a href="pharfileinfo.setcompressedgz.html" class="function" rel="rdfs-seeAlso">PharFileInfo::setCompressedGZ()</a> - Compresses the current Phar entry within the phar using gz compression</span></li>
    <li class="member"><span class="function"><a href="phar.cancompress.html" class="function" rel="rdfs-seeAlso">Phar::canCompress()</a> - Returns whether phar extension supports compression using either zlib or bzip2</span></li>
    <li class="member"><span class="function"><a href="phar.iscompressed.html" class="function" rel="rdfs-seeAlso">Phar::isCompressed()</a> - Returns Phar::GZ or PHAR::BZ2 if the entire phar archive is compressed (.tar.gz/tar.bz and so on)</span></li>
    <li class="member"><span class="function"><a href="phar.compressallfilesbzip2.html" class="function" rel="rdfs-seeAlso">Phar::compressAllFilesBZIP2()</a> - Compresses all files in the current Phar archive using Bzip2 compression</span></li>
    <li class="member"><span class="function"><a href="phar.getsupportedcompression.html" class="function" rel="rdfs-seeAlso">Phar::getSupportedCompression()</a> - Return array of supported compression algorithms</span></li>
    <li class="member"><span class="function"><a href="phar.uncompressallfiles.html" class="function" rel="rdfs-seeAlso">Phar::uncompressAllFiles()</a> - Uncompresses all files in the current Phar archive</span></li>
   </ul>
  </p>
 </div>


</div><hr /><div class="manualnavbar" style="text-align: center;">
 <div class="prev" style="text-align: left; float: left;"><a href="phar.compressallfilesbzip2.html">Phar::compressAllFilesBZIP2</a></div>
 <div class="next" style="text-align: right; float: right;"><a href="phar.compressfiles.html">Phar::compressFiles</a></div>
 <div class="up"><a href="class.phar.html">Phar</a></div>
 <div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
